/*****************************************************************************
 *
 * This MobilityDB code is provided under The PostgreSQL License.
 * Copyright (c) 2016-2024, Université libre de Bruxelles and MobilityDB
 * contributors
 *
 * MobilityDB includes portions of PostGIS version 3 source code released
 * under the GNU General Public License (GPLv2 or later).
 * Copyright (c) 2001-2024, PostGIS contributors
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without a written
 * agreement is hereby granted, provided that the above copyright notice and
 * this paragraph and the following two paragraphs appear in all copies.
 *
 * IN NO EVENT SHALL UNIVERSITE LIBRE DE BRUXELLES BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
 * LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
 * EVEN IF UNIVERSITE LIBRE DE BRUXELLES HAS BEEN ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * UNIVERSITE LIBRE DE BRUXELLES SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON
 * AN "AS IS" BASIS, AND UNIVERSITE LIBRE DE BRUXELLES HAS NO OBLIGATIONS TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 *****************************************************************************/

/**
 * @brief Functions for spatiotemporal bounding boxes.
 */

#ifndef __TPOINT_TILE_H__
#define __TPOINT_TILE_H__

/* MEOS */
#include <meos.h>

#define MAXDIMS 4

/*****************************************************************************/

/**
 * Structure for storing a bit matrix
 */
typedef struct
{
  int ndims;             /**< Number of dimensions */
  int count[MAXDIMS];    /**< Number of elements in each dimension */
  uint8_t byte[1];       /**< beginning of variable-length data */
} BitMatrix;

/**
 * Struct for storing the state that persists across multiple calls generating
 * a multidimensional grid
 */
typedef struct STboxGridState
{
  bool done;               /**< True when all tiles have been processed */
  bool hasx;               /**< True when tiles have X dimension */
  bool hasz;               /**< True when tiles have Z dimension */
  bool hast;               /**< True when tiles have T dimension */
  int i;                   /**< Number of current tile */
  double xsize;            /**< Size of the x dimension */
  double ysize;            /**< Size of the y dimension */
  double zsize;            /**< Size of the z dimension, 0 for 2D */
  int64 tunits;            /**< Size of the time dimension, 0 for spatial only */
  STBox box;               /**< Bounding box of the grid */
  const Temporal *temp;    /**< Optional temporal point to be split */
  BitMatrix *bm;           /**< Optional bit matrix for speeding up the
                              computation of the split functions */
  double x;                /**< Minimum x value of the current tile */
  double y;                /**< Minimum y value of the current tile */
  double z;                /**< Minimum z value of the current tile, if any */
  TimestampTz t;           /**< Minimum t value of the current tile, if any */
  int ntiles;              /**< Total number of tiles */
  int max_coords[MAXDIMS]; /**< Maximum coordinates of the tiles */
  int coords[MAXDIMS];     /**< Coordinates of the current tile */
} STboxGridState;

/*****************************************************************************/

extern BitMatrix *bitmatrix_make(int *count, int ndims);
extern int tpoint_set_tiles(const Temporal *temp, const STboxGridState *state,
  BitMatrix *bm);
extern Temporal *tpoint_at_tile(const Temporal *temp, const STBox *box);

extern void stbox_tile_state_set(double x, double y, double z, TimestampTz t,
  double xsize, double ysize, double zsize, int64 tunits, bool hasx, bool hasz,
  bool hast, int32 srid, STBox *result);
extern STboxGridState *stbox_tile_state_make(const Temporal *temp,
  const STBox *box, double xsize, double ysize, double zsize, 
  const Interval *duration, POINT3DZ sorigin, TimestampTz torigin, 
  bool border_inc);
extern void stbox_tile_state_next(STboxGridState *state);
extern bool stbox_tile_state_get(STboxGridState *state, STBox *box);

extern STboxGridState *tpoint_space_time_tile_init(const Temporal *temp,
  double xsize, double ysize, double zsize, const Interval *duration,
  const GSERIALIZED *sorigin, TimestampTz torigin, bool bitmatrix, 
  bool border_inc, int *ntiles);

extern STBox *stbox_space_time_tile_common(const GSERIALIZED *point,
  TimestampTz t, double xsize, double ysize, double zsize,
  const Interval *duration, const GSERIALIZED *sorigin, TimestampTz torigin,
  bool hasx, bool hast);

/*****************************************************************************/

#endif
